Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThe pull request restructures the Kotlin SDK navigation entry from an external link to an internal documentation hub, then adds eleven comprehensive API reference documentation pages for the Kotlin Chat SDK covering ChatClient, Connection, Rooms, Room, Messages, Message, MessageReactions, RoomReactions, Presence, Occupancy, and Typing interfaces. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
ea78770 to
2cb6203
Compare
GregHolmes
left a comment
There was a problem hiding this comment.
Looks good! Just left a couple comments.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
src/pages/docs/chat/api/kotlin/message-reactions.mdx (1)
15-18: Remove bold prefixes from bullet labels.The strategy bullets use bold prefixes (
**Unique**, etc.). Please switch to plain bullet labels to match style guidance.As per coding guidelines "Avoid em-dashes, Latin abbreviations, slang, and bold prefixes in bullet points".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/pages/docs/chat/api/kotlin/message-reactions.mdx` around lines 15 - 18, Update the three bullets in message-reactions.mdx to remove the bold markdown around the strategy names; replace "**Unique**:", "**Distinct**:", and "**Multiple**:" with plain text labels "Unique:", "Distinct:", and "Multiple:" so the bullets read "Unique: One reaction per client...", "Distinct: One reaction of each type...", and "Multiple: Unlimited reactions..."; keep the rest of the sentences unchanged to match the style guideline against bold prefixes.src/pages/docs/chat/api/kotlin/typing.mdx (1)
104-112: Consider documentingTypingSetEventTypevalues.The
typeproperty referencesTypingSetEventTypebut its possible values aren't documented. If this type has specific enum values (similar to howTypingEventTypedocumentsStarted/Stopped), consider adding a hidden table or inline description for completeness.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/pages/docs/chat/api/kotlin/typing.mdx` around lines 104 - 112, The docs reference TypingSetEvent.type (TypingSetEventType) but don't list its possible values; add documentation for TypingSetEventType (either a hidden <Table id='TypingSetEventType'> or an inline description) enumerating each enum member and its meaning (similar to TypingEventType's Started/Stopped example) and update the TypingSetEvent table to link to that TypingSetEventType entry so readers can see the allowed values and semantics.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/pages/docs/chat/api/kotlin/message-reactions.mdx`:
- Around line 75-80: Update the documented exception type for the suspend
functions send(), delete(), and clientReactions() so their "Returns" sections
reference ChatException instead of ErrorInfo (the Kotlin Chat SDK throws
ChatException on suspend failures); locate the three Returns blocks for send(),
delete(), and clientReactions() and replace the ErrorInfo mention with
ChatException, preserving the rest of the sentence. Additionally, remove the
bold prefixes from the bullet list items near the top of the file (the three
bullets that currently start with bold text) to match the writing style
guideline.
In `@src/pages/docs/chat/api/kotlin/occupancy.mdx`:
- Around line 52-57: The docs incorrectly say the suspend function get() throws
ErrorInfo; update the return/throws section for OccupancyData to state that
suspend failures throw ChatException (which wraps ErrorInfo) to match the
ChatClient suspend semantics. Locate the paragraph under "Returns" for
OccupancyData and replace the reference to `ErrorInfo` with `ChatException`,
keeping the note that it wraps `ErrorInfo` for clarity.
In `@src/pages/docs/chat/api/kotlin/presence.mdx`:
- Around line 44-49: Update the documentation return sections in this
presence.mdx file to state that these suspend functions throw ChatException
(which wraps ErrorInfo) instead of ErrorInfo directly; find each occurrence of
`ErrorInfo` in the "Returns" paragraphs for the suspend methods and replace the
text to reference `ChatException` consistent with the ChatClient API docs and
mention that ChatException contains the underlying ErrorInfo details.
In `@src/pages/docs/chat/api/kotlin/room-reactions.mdx`:
- Around line 45-50: Update the documentation for the suspend function send() in
room-reactions.mdx so that the documented thrown type is ChatException instead
of ErrorInfo; replace the reference to [`ErrorInfo`] with [`ChatException`]
(which wraps ErrorInfo) in the "Returns" / error sentence so it matches the
Kotlin Chat SDK convention used in chat-client.mdx.
In `@src/pages/docs/chat/api/kotlin/room.mdx`:
- Around line 70-75: Update the error documentation for the suspend functions
attach() and detach(): replace mentions of throwing [`ErrorInfo`] with
[`ChatException`] and point the link to
/docs/chat/api/kotlin/chat-client#chatexception; specifically edit the
Returns/description text for the attach() and detach() sections so they read
that the suspend function completes when the room is attached/detached or throws
a [`ChatException`] on failure (ChatException wraps ErrorInfo).
---
Nitpick comments:
In `@src/pages/docs/chat/api/kotlin/message-reactions.mdx`:
- Around line 15-18: Update the three bullets in message-reactions.mdx to remove
the bold markdown around the strategy names; replace "**Unique**:",
"**Distinct**:", and "**Multiple**:" with plain text labels "Unique:",
"Distinct:", and "Multiple:" so the bullets read "Unique: One reaction per
client...", "Distinct: One reaction of each type...", and "Multiple: Unlimited
reactions..."; keep the rest of the sentences unchanged to match the style
guideline against bold prefixes.
In `@src/pages/docs/chat/api/kotlin/typing.mdx`:
- Around line 104-112: The docs reference TypingSetEvent.type
(TypingSetEventType) but don't list its possible values; add documentation for
TypingSetEventType (either a hidden <Table id='TypingSetEventType'> or an inline
description) enumerating each enum member and its meaning (similar to
TypingEventType's Started/Stopped example) and update the TypingSetEvent table
to link to that TypingSetEventType entry so readers can see the allowed values
and semantics.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 880a6552-3542-454e-83dd-7dce979f23ec
📒 Files selected for processing (12)
src/data/nav/chat.tssrc/pages/docs/chat/api/kotlin/chat-client.mdxsrc/pages/docs/chat/api/kotlin/connection.mdxsrc/pages/docs/chat/api/kotlin/message-reactions.mdxsrc/pages/docs/chat/api/kotlin/message.mdxsrc/pages/docs/chat/api/kotlin/messages.mdxsrc/pages/docs/chat/api/kotlin/occupancy.mdxsrc/pages/docs/chat/api/kotlin/presence.mdxsrc/pages/docs/chat/api/kotlin/room-reactions.mdxsrc/pages/docs/chat/api/kotlin/room.mdxsrc/pages/docs/chat/api/kotlin/rooms.mdxsrc/pages/docs/chat/api/kotlin/typing.mdx
Add navigation entries for all 11 Kotlin Chat API reference pages, replacing the external Dokka SDK link with inline page links mirroring the JavaScript API reference structure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add ChatException section, experimental annotations on realtime and stateDispatcher properties, Required column consistency for param tables, and DSL builder overload method signature. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add DSL builder overload method signature for rooms.get() and apply Required column consistency to parameter tables. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add experimental channel property, convert property tables to use description-based nullability instead of Required column for interface properties. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add extension function overload signatures for update() and delete(), remove nullable type syntax from parameter tables. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Separate with() overloads into distinct signature blocks with code examples, convert property tables to description-based nullability. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove nullable type syntax from parameter tables, convert PresenceMember to description-based nullability for interface properties. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove nullable type syntax from parameter tables. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Convert property tables to description-based nullability for interface properties. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2cb6203 to
f75777b
Compare
Description
This PR adds a Kotlin Chat API reference into the docs. It follows a similar format to the JavaScript ones, however should be idiomatic where necessary. Uses the Dokka references as source.
Checklist
Summary by CodeRabbit